Azure Maps Route Service (preview:2024-07-01)

2025/01/10 • 3 updated methods

Route_PostRouteRange (updated)
Description :  **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Route Range API creates a polygon that depicts the area reachable from a given location within a certain threshold based on the specified time or distance budget. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point. The returned polygon can be used for spatial filtering to search for features of interest within the provided Isochrone. For information about routing availability in countries/regions, see [Azure Maps routing coverage](https://learn.microsoft.com/azure/azure-maps/routing-coverage?pivots=route-v2). >[!Important] >By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Route_PostRouteRange",
  "$parameters": {
    "routeRangeRequest": {
      "$properties": {
        "properties": [
          {
            "#name": "isSimplifiedPolygon",
            "Description": {
              "new": "Use this to specify if you need simplified polygons that reduces the number of polygon vertices while preserving the shape. The API returns low definition polygon by default.",
              "old": "Use this to specify if you need simplified polygons that reduces the number of polygon vertices while preserving the shape. The API returns high definition polygon by default."
            }
          },
          {
            "#name": "distanceBudgetInMeters ",
            "Description": {
              "new": "The distance budget specifies the maximum range in meters which can be traveled from the origin waypoint. It cannot be set when `timeBudgetInSec` is specified.\n\nWhen `isSimplifiedPolygon` is false, the maximum distance supported is 360,000 meters; otherwise, it is 500,000 meters.\n\nExample: \"distanceBudgetInMeters\":5000",
              "old": "The distance budget specifies the maximum range in meters which can be travelled from the origin waypoint. It cannot be set when `timeBudgetInSec` is specified.\n\nWhen `isSimplifiedPolygon` is false, the maximum distance supported is 360,000 meters; otherwise, it is 50,000,000 meters.\n\nExample: \"distanceBudgetInMeters\":5000"
            }
          },
          {
            "#name": "timeBudgetInSec",
            "Description": {
              "new": "The time budget specifies the maximum time in seconds available for travel, defining how far one can go within this time constraint from the origin waypoint. It cannot be set when `distanceBudgetInMeters` is specified.\n\nWhen `isSimplifiedPolygon` is false, the maximum time supported is 14,400 seconds; otherwise, it is 21,600 seconds.\n\nExample: \"timeBudgetInSec\":3600",
              "old": "The time budget specifies the maximum time in seconds available for travel, defining how far one can go within this time constraint from the origin waypoint. It cannot be set when `distanceBudgetInMeters` is specified.\n\nWhen `isSimplifiedPolygon` is false, the maximum time supported is 14,400 seconds; otherwise, it is 10,000,000 seconds.\n\nExample: \"timeBudgetInSec\":3600"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /route/range
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
routeRangeRequest:
{
Description: Request body of RouteRange API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: Specifies the `GeoJSON` Point Geometry object. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details. ,
Required: True ,
}
object ,
properties:
{
Description: Specifies the parameters to use for the calculation of isochrone polygon. ,
Required: True ,
}
{
departAt:
{
Description: The date and time of departure from the origin point formatted as a dateTime value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. If the `departAt` is not set, the default value is the current time. Example: "departAt": "2023-06-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
isSimplifiedPolygon:
{
Description: Use this to specify if you need simplified polygons that reduces the number of polygon vertices while preserving the shape. The API returns low definition polygon by default. ,
Required: False ,
}
boolean ,
optimizeRoute:
{
Description: Specifies the parameter to use to optimize the route. If not defined, the default is "fastestWithoutTraffic" which returns the route to minimize the travel time without using current traffic information. Example: "optimizeRoute":"shortest" ,
Enum:
{
shortest: The route is calculated to minimize the distance. Traffic information is not used. ,
fastestWithoutTraffic: Finds the fastest route, without factoring in traffic information. ,
fastestWithTraffic: The route is calculated to minimize the time using current traffic information. `Note`: Only supported for driving and truck travelMode. ,
}
,
Required: False ,
}
enum ,
avoid:
{
Description: Specifies restrictions that the route calculation should honor when determining the reachable locations. Avoid supports multiple values in a request. Example: "avoid": ["limitedAccessHighways", "tollRoads"] ,
Required: False ,
}
[
string ,
]
,
vehicleSpec:
{
Description: Specifies the vehicle attributes such as vehicle height, weight, max speed, type of cargo, etc. to consider when calculating the reachable locations. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized truck route based on the vehicle specifications. Vehicle attributes are specified within the vehicleSpec property. ,
Required: False ,
}
object ,
distanceBudgetInMeters :
{
Description: The distance budget specifies the maximum range in meters which can be traveled from the origin waypoint. It cannot be set when `timeBudgetInSec` is specified. When `isSimplifiedPolygon` is false, the maximum distance supported is 360,000 meters; otherwise, it is 500,000 meters. Example: "distanceBudgetInMeters":5000 ,
Required: False ,
}
number ,
timeBudgetInSec:
{
Description: The time budget specifies the maximum time in seconds available for travel, defining how far one can go within this time constraint from the origin waypoint. It cannot be set when `distanceBudgetInMeters` is specified. When `isSimplifiedPolygon` is false, the maximum time supported is 14,400 seconds; otherwise, it is 21,600 seconds. Example: "timeBudgetInSec":3600 ,
Required: False ,
}
number ,
travelMode:
{
Description: Specifies the travel profile to consider when calculating the range polygon. If not specified, the default value is "driving". Example: "travelMode":"driving" ,
Enum:
{
driving: Routing profile suitable for cars are used for range polygon calculation. ,
truck: Routing profile suitable for commercial vehicles like trucks are used for range polygon calculation. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: `GeoJSON` feature object that contains Geometry object and additional properties. Refer to [RFC 7946, Section 3.2](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) for details. ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostRouteMatrix (updated)
Description :  **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The `Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a sync request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. Route Matrices can be calculated for driving, walking and truck routes. For example, a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call the Route Matrix API and use the travel cost to sort the drivers by their actual travel distance or time from the restaurant. Route Matrices are used in several different types of applications, most commonly to solve the Traveling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for sync request it's **2500** (the number of origins multiplied by the number of destinations). ### Submit Synchronous Route Matrix Request If your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 2500, you might want to make synchronous request. The maximum size of a matrix for this API is **2500** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x50, 60x40, 90x20 (it does not need to be square). ### API Limitations The synchronous processing of matrix is best suited for fast, small matrices of route calculation. To calculate larger matrices and heavy route calculation, use the asynchronous endpoint. The following limitation is applicable to the synchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed. | Max matrix size | Max number of origins | Max number of destinations | Additional limits |------------------|------------------------|----------------------------|------------| | 100 | 100 | 100 | N/A | | 200 | 200 | 200 | All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise, some matrix cells will be resolved as OUT_OF_REGION. | | 2500 | 1000 | 1000 | - `departAt` or `arriveAt` must be any.
- `traffic` must be historical.
- `travelMode` must be either driving or truck
- No other parameters can be used explicitly | Examples: - Request of 10x20 matrix with `traffic=live`: This request will be processed with a bounding box limit, as it matches a limit of up to 200, which includes bounding box restrictions. - Request of 10x20 matrix with default parameters (`traffic=historical`): This request will be processed without a bounding box limit, as it matches a limit of up to 2500, which does not impose bounding box restrictions.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Route_PostRouteMatrix",
  "Description": {
    "new": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe `Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a sync request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. Route Matrices can be calculated for driving, walking and truck routes. For example, a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call the Route Matrix API and use the travel cost to sort the drivers by their actual travel distance or time from the restaurant.\n\n\nRoute Matrices are used in several different types of applications, most commonly to solve the Traveling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for sync request it's **2500** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 2500, you might want to make synchronous request. The maximum size of a matrix for this API is **2500** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x50, 60x40, 90x20 (it does not need to be square).\n\n\n\n### API Limitations\n The synchronous processing of matrix is best suited for fast, small matrices of route calculation. To calculate larger matrices and heavy route calculation, use the asynchronous endpoint. The following limitation is applicable to the synchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed.\n\n| Max matrix size | Max number of origins  | Max number of destinations | Additional limits\n |------------------|------------------------|----------------------------|------------|\n| 100              | 100         | 100              | N/A |\n| 200              | 200         | 200              | All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise, some matrix cells will be resolved as OUT_OF_REGION.  |\n| 2500             | 1000        | 1000             | - `departAt` or `arriveAt` must be any.
 - `traffic` must be historical.
 - `travelMode` must be either driving or truck
 - No other parameters can be used explicitly   |\n\n\nExamples:\n - Request of 10x20 matrix with `traffic=live`: This request will be processed with a bounding box limit, as it matches a limit of up to 200, which includes bounding box restrictions.\n\n - Request of 10x20 matrix with default parameters (`traffic=historical`): This request will be processed without a bounding box limit, as it matches a limit of up to 2500, which does  not impose bounding box restrictions.\n\n\n",
    "old": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe `Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a sync request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. Route Matrices can be calculated for driving, walking and truck routes. For example, a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call the Route Matrix API and use the travel cost to sort the drivers by their actual travel distance or time from the restaurant.\n\n\nRoute Matrices are used in several different types of applications, most commonly to solve the Travelling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for sync request it's **2500** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 2500, you might want to make synchronous request. The maximum size of a matrix for this API is **2500** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x50, 60x40, 90x20 (it does not need to be square).\n\n\n\n### API Limitations\n The synchronous processing of matrix is best suited for fast, small matrices of route calculation. To calculate larger matrices and heavy route calculation, use the asynchronous endpoint. The following limitation is applicable to the synchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed.\n\n| Max matrix size | Max number of origins  | Max number of destinations | Additional limits\n |------------------|------------------------|----------------------------|------------|\n| 100              | 100         | 100              | N/A |\n| 200              | 200         | 200              | All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise, some matrix cells will be resolved as OUT_OF_REGION.  |\n| 2500             | 1000        | 1000             | - `departAt` or `arriveAt` must be any.
 - `traffic` must be historical.
 - `travelMode` must be either driving or truck
 - No other parameters can be used explicitly   |\n\n\nExamples:\n - Request of 10x20 matrix with `traffic=live`: This request will be processed with a bounding box limit, as it matches a limit of up to 200, which includes bounding box restrictions.\n\n - Request of 10x20 matrix with default parameters (`traffic=historical`): This request will be processed without a bounding box limit, as it matches a limit of up to 2500, which does  not impose bounding box restrictions.\n\n\n"
  }
}

⚼ Request

POST:  /route/matrix
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
routeMatrixRequest:
{
Description: Request body of RouteMatrix API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: A set of origin and destination points passed as GeoJSON MultiPoint features for the input matrix. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. ,
Required: True ,
}
object ,
properties:
{
Description: MultiPoint feature properties object which specifies the origin features and destination features for the input matrix. ,
Required: True ,
}
{
pointType:
{
Description: Specifies the origin MultiPoint type and destination MultiPoint type for the input matrix. ,
Enum:
{
origins: MultiPoint features that define the origin locations in the input matrix. ,
destinations: MultiPoint features that define the destination locations in the input matrix. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
departAt:
{
Description: The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The `departAt` parameter cannot be used in conjunction with `arriveAt`. The `departAt` also supports: `any` value tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`. `now` value to set the departure time to the processing time of each individual cell. Processing time may be any time between submission and its completion. This mode is best used together with traffic=live. Default value: `any` if `departAt` is not specified. Example: "departAt": "2024-12-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
arriveAt:
{
Description: The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The `arriveAt` parameter cannot be used in conjunction with `departAt`. The `arriveAt` also supports `any` value which is tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`. Default value: `any` if `arriveAt` is not specified. Example: "arriveAt": "2024-12-01T09:30:00.000-07:00" ,
Format: date-time ,
Required: False ,
}
string ,
travelMode:
{
Description: Specifies the travel profile to consider when calculating the matrix. If not specified, the default value is "driving". Example: "travelMode":"driving" ,
Enum:
{
driving: Routing profile suitable for cars are used for route matrix calculation. ,
truck: Routing profile suitable for commercial vehicles like trucks are used for route matrix calculation. ,
walking: The returned routes are optimized for pedestrians, including the use of sidewalks. ,
}
,
Required: False ,
}
enum ,
optimizeRoute:
{
Description: Specifies the parameter to use to optimize the route. If not defined, the default is "fastest" which returns the route to minimize the travel time. Example: "optimizeRoute":"fastest " ,
Enum:
{
fastest: Finds the fastest route to optimize route by travel time. Only `fastest` is supported for the Route Matrix sync API. To use the other types, check the Route Matrix async API. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Specifies how traffic is considered for computing routes. Default value: `historical` ,
Enum:
{
historical: Route calculation considers historical travel times and long term closures. Traffic jams and short-term closures during the travel time window do not influence routing or travel time. ,
live: In addition to historical travel times, route calculation considers traffic jams and short- and long-term closures during the travel time window. `Note`: `traffic=live` may not be used in conjunction with `arriveAt=any` and `departAt=any` ,
}
,
Required: False ,
}
enum ,
avoid:
{
Description: Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode. ,
Required: False ,
}
[
string ,
]
,
vehicleSpec:
{
Description: Specifies the vehicle attributes such as vehicle height, weight, max speed, type of cargo, etc. to consider when calculating the route matrix. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized route based on the vehicle specifications. Vehicle attributes are specified within the vehicleSpec property. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: The geometry object is null ,
Required: True ,
}
object ,
properties:
{
Description: Route Matrix properties. ,
Required: True ,
}
{
summary:
{
Description: Summary for the route matrix request ,
Required: False ,
}
{
successfulCount:
{
Description: Number of successful routes within this matrix. ,
Format: int32 ,
Required: False ,
}
integer ,
totalCount:
{
Description: Total number of routes within this matrix. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
matrix:
{
Description: The matrix of route results. ,
Required: False ,
}
[
{
statusCode:
{
Description: The HTTP status code of the current cell. ,
Format: int32 ,
Required: False ,
}
integer ,
originIndex:
{
Description: Index of the origin point ,
Format: int32 ,
Required: False ,
}
integer ,
destinationIndex:
{
Description: Index of the destination point ,
Format: int32 ,
Required: False ,
}
integer ,
departureTime:
{
Description: The estimated departure time, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used. If departAt or arriveAt is `any`, then departureTime is absent. ,
Format: date-time ,
Required: False ,
}
string ,
arrivalTime:
{
Description: The estimated arrival time, which takes into account the traffic conditions, is formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). It will reference the timezone offset by either `departAt` or `arrivalAt`. If not, then the UTC time will be used. If departAt or arriveAt is any, then departureTime is absent. ,
Format: date-time ,
Required: False ,
}
string ,
distanceInMeters:
{
Description: Length In Meters property ,
Required: False ,
}
number ,
durationInSeconds:
{
Description: Estimated travel time in seconds that does not include delays on the route due to traffic conditions. ,
Format: int64 ,
Required: False ,
}
integer ,
durationTrafficInSeconds:
{
Description: The time that it takes, in seconds, to travel a corresponding `TravelDistance` with current traffic conditions. This value is provided if `optimizeRoute` includes traffic considerations. ,
Format: int64 ,
Required: False ,
}
integer ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Route_PostRouteMatrixAsync (updated)
Description :  **Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The `Route Matrix Async` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. Route Matrices can be calculated for driving, walking and truck routes. Route Matrices are used in several different types of applications, most commonly to solve the Traveling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API. The maximum size of a matrix for async request is **50000** (the number of origins multiplied by the number of destinations). ### Submit Asynchronous Route Matrix Request The Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a URL in the `operation-Location` field of the response header with the Azure Maps geography endpoint `{geography}.atlas.microsoft.com. This URL should be checked periodically until the status is Succeeded. The maximum size of a matrix for this API is **50000** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 500x100, 100x100, 280x170. 100x50 (it does not need to be square). The asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period. ``` POST https://atlas.microsoft.com/route/matrix:async?api-version=2024-07-01-preview&subscription-key={subscription-key} ``` Here's a typical sequence of asynchronous operations: 1. Client sends a Route Matrix POST request to Azure Maps 2. The server will respond with one of the following: > HTTP `202 Accepted` - Route Matrix request has been accepted. > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code. 3. If the Matrix Route request was accepted successfully, the `operation-location` header in the response contains the URL to get the status of the request. This status URI looks like the following: ``` GET https://atlas.microsoft.com/route/operations/{id}?api-version=2024-07-01-preview?subscription-key={subscription-key} ``` 4. Client issues a GET request on the resultUrl obtained in Step 3 to get the results ``` GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2024-07-01-preview?subscription-key={subscription-key} ``` ### API Limitations The asynchronous processing of matrix is best suited for larger matrices that require heavy route calculation. The following limitation is applicable to the asynchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed. > Async requests supports up to 50K matrix size in a single request. If you want to request an increase to this limit, you can create an Azure Maps Technical Support Request in the Azure portal. | Max matrix size  | Max number of origins | Max number of destinations  | Additional limits | |------------------|-----------------------|-----------------------------|-------------------| | 2500  | 1000  | 1000  | All origins and destinations should be contained in an axis-aligned 400 km x 400 km bounding box. Otherwise some matrix cells will be resolved as OUT_OF_REGION.  | | 50,000  | 10,000  | 10,000  | - `departAt` or `arriveAt` must be any.
- `traffic` must be historical.
- `optimizeRoute` must be fastest.
- `travelMode` must be either driving or truck. 
- No other parameters can be used explicitly.  |
Reference :  Link ¶

⚶ Changes

{
  "#id": "Route_PostRouteMatrixAsync",
  "Description": {
    "new": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe `Route Matrix Async` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell.  Route Matrices can be calculated for driving, walking and truck routes.\n\nRoute Matrices are used in several different types of applications, most commonly to solve the Traveling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **50000** (the number of origins multiplied by the number of destinations).\n\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a URL in the `operation-Location` field of the response header with the Azure Maps geography endpoint `{geography}.atlas.microsoft.com. This URL should be checked periodically until the status is Succeeded. \n\n\nThe maximum size of a matrix for this API is **50000** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 500x100, 100x100, 280x170. 100x50 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix:async?api-version=2024-07-01-preview&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` -  Route Matrix request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the `operation-location` header in the response contains the URL to get the status of the request. This status URI looks like the following:\n\n  ```\n    GET https://atlas.microsoft.com/route/operations/{id}?api-version=2024-07-01-preview?subscription-key={subscription-key}\n  ```\n\n\n4. Client issues a GET request on the resultUrl obtained in Step 3 to get the results\n\n \n\n  ```\n    GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2024-07-01-preview?subscription-key={subscription-key}\n   ```\n\n\n\n ### API Limitations\n The asynchronous processing of matrix is best suited for larger matrices that require heavy route calculation. The following limitation is applicable to the asynchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed.\n\n > Async requests supports up to 50K matrix size in a single request. If you want to request an increase to this limit, you can create an Azure Maps Technical Support Request in the Azure portal.\n\n \n| Max matrix\u00a0size\u00a0 | Max number\u00a0of origins | Max number\u00a0of destinations\u00a0 | Additional limits\u00a0|\n|------------------|-----------------------|-----------------------------|-------------------|\n| 2500\u00a0            | 1000\u00a0                 | 1000\u00a0                       | All origins and destinations should be contained in an axis-aligned 400\u202fkm\u202fx\u202f400\u202fkm bounding box. Otherwise some matrix cells will be resolved as\u202fOUT_OF_REGION.\u00a0 |\n| 50,000\u00a0          | 10,000\u00a0               | 10,000\u00a0                     | - `departAt`\u202for\u202f`arriveAt`\u202fmust be\u202fany.
- `traffic`\u202fmust be\u202fhistorical.
- `optimizeRoute` must be\u202ffastest.
- `travelMode`\u202fmust be either\u202fdriving\u202for\u202ftruck.\u00a0
- No other parameters can be used explicitly.\u00a0 |\n\n\n",
    "old": "**Applies to**: see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\n\nThe `Route Matrix Async` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell.  Route Matrices can be calculated for driving, walking and truck routes.\n\nRoute Matrices are used in several different types of applications, most commonly to solve the Travelling Salesman Problem (TSP) and Vehicle Routing Problem (VRP). For each origin-destination pair in the matrix, the travel time and distance are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **50000** (the number of origins multiplied by the number of destinations).\n\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a URL in the `operation-Location` field of the response header with the Azure Maps geography endpoint `{geography}.atlas.microsoft.com. This URL should be checked periodically until the status is Succeeded. \n\n\nThe maximum size of a matrix for this API is **50000** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 500x100, 100x100, 280x170. 100x50 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix:async?api-version=2024-07-01-preview&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n    > HTTP `202 Accepted` -  Route Matrix request has been accepted.\n\n    > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the `operation-location` header in the response contains the URL to get the status of the request. This status URI looks like the following:\n\n  ```\n    GET https://atlas.microsoft.com/route/operations/{id}?api-version=2024-07-01-preview?subscription-key={subscription-key}\n  ```\n\n\n4. Client issues a GET request on the resultUrl obtained in Step 3 to get the results\n\n \n\n  ```\n    GET https://atlas.microsoft.com/route/operations/{id}/result?api-version=2024-07-01-preview?subscription-key={subscription-key}\n   ```\n\n\n\n ### API Limitations\n The asynchronous processing of matrix is best suited for larger matrices that require heavy route calculation. The following limitation is applicable to the asynchronous requests. If none of the rows in the following table match the request's parameters, the request does not meet the requirements and will not be processed.\n\n > Async requests supports up to 50K matrix size in a single request. If you want to request an increase to this limit, you can create an Azure Maps Technical Support Request in the Azure portal.\n\n \n| Max matrix\u00a0size\u00a0 | Max number\u00a0of origins | Max number\u00a0of destinations\u00a0 | Additional limits\u00a0|\n|------------------|-----------------------|-----------------------------|-------------------|\n| 2500\u00a0            | 1000\u00a0                 | 1000\u00a0                       | All origins and destinations should be contained in an axis-aligned 400\u202fkm\u202fx\u202f400\u202fkm bounding box. Otherwise some matrix cells will be resolved as\u202fOUT_OF_REGION.\u00a0 |\n| 50,000\u00a0          | 10,000\u00a0               | 10,000\u00a0                     | - `departAt`\u202for\u202f`arriveAt`\u202fmust be\u202fany.
- `traffic`\u202fmust be\u202fhistorical.
- `optimizeRoute` must be\u202ffastest.
- `travelMode`\u202fmust be either\u202fdriving\u202for\u202ftruck.\u00a0
- No other parameters can be used explicitly.\u00a0 |\n\n\n"
  }
}

⚼ Request

POST:  /route/matrix:async
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
routeMatrixAsyncRequest:
{
Description: Request body of RouteMatrix API in GeoJSON format. ,
Required: True ,
}
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is `FeatureCollection`. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
FeatureCollection: Specifies the `GeoJSON` `FeatureCollection` object type. ,
}
,
Required: True ,
}
enum ,
features:
{
Description: A set of origin and destination points passed as GeoJSON MultiPoint features for the input matrix. Refer to [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946) for details on the GeoJSON format. ,
Required: True ,
}
[
{
type:
{
Description: Specifies the `GeoJSON` type. The only supported object type is Feature. For more information, see [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946). ,
Enum:
{
Feature: Specifies the `GeoJSON` Feature object type. ,
}
,
Required: True ,
}
enum ,
geometry:
{
Description: A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details. ,
Required: True ,
}
object ,
properties:
{
Description: MultiPoint feature properties object which specifies the origin features and destination features for the input matrix. ,
Required: True ,
}
{
pointType:
{
Description: Specifies the origin MultiPoint type and destination MultiPoint type for the input matrix. ,
Enum:
{
origins: MultiPoint features that define the origin locations in the input matrix. ,
destinations: MultiPoint features that define the destination locations in the input matrix. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
departAt:
{
Description: The date and time of departure from the origin point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The `departAt` parameter cannot be used in conjunction with `arriveAt`. The `departAt` also supports: `any` value tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`. `now` value to set the departure time to the processing time of each individual cell. Processing time may be any time between submission and its completion. This mode is best used together with traffic=live. Default value: `any` if `departAt` is not specified. Example: "departAt": "2024-12-01T09:30:00.000-07:00" ,
Required: False ,
}
string ,
arriveAt:
{
Description: The date and time of arrival at the destination point formatted as a `dateTime` value defined by [RFC 3339, section 5.6](https://www.rfc-editor.org/rfc/rfc3339#section-5.6). When a time zone offset is not specified, UTC will be assumed. The `arriveAt` parameter cannot be used in conjunction with `departAt`. The `arriveAt` also supports `any` value which is tailored to the use case where the time context is irrelevant. The `traffic=live` parameter value cannot be used together with `any`. Default value: `any` if `arriveAt` is not specified. Example: "arriveAt": "2024-12-01T09:30:00.000-07:00" ,
Required: False ,
}
string ,
travelMode:
{
Description: Specifies the travel profile to consider when calculating the matrix. If not specified, the default value is "driving". Example: "travelMode":"driving" ,
Enum:
{
driving: Routing profile suitable for cars are used for route matrix calculation. ,
truck: Routing profile suitable for commercial vehicles like trucks are used for route matrix calculation. ,
walking: The returned routes are optimized for pedestrians, including the use of sidewalks. ,
}
,
Required: False ,
}
enum ,
optimizeRoute:
{
Description: Specifies the parameter to use to optimize the route. If not defined, the default is "fastest" which returns the route to minimize the travel time. Example: "optimizeRoute":"shortest" ,
Enum:
{
shortest: Finds the shortest route to optimize route by travel distance. ,
fastest: Finds the fastest route to optimize route by travel time. ,
}
,
Required: False ,
}
enum ,
traffic:
{
Description: Specifies how traffic is considered for computing routes. Default value: `historical` ,
Enum:
{
historical: Route calculation considers historical travel times and long term closures. Traffic jams and short-term closures during the travel time window do not influence routing or travel time. ,
live: In addition to historical travel times, route calculation considers traffic jams and short- and long-term closures during the travel time window. `Note`: `traffic=live` may not be used in conjunction with `arriveAt=any` and `departAt=any` ,
}
,
Required: False ,
}
enum ,
avoid:
{
Description: Specifies restrictions that the route calculation should honor when determining the route. Avoid supports multiple values in a request and is only supported for the driving and truck travelMode. ,
Required: False ,
}
[
string ,
]
,
vehicleSpec:
{
Description: Specifies the vehicle attributes such as vehicle height, weight, max speed, type of cargo, etc. to consider when calculating the route matrix. This helps avoid low bridge clearances, road restrictions, difficult right turns to provide the optimized route based on the vehicle specifications. Vehicle attributes are specified within the vehicleSpec property. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: URL to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code of the error that occurred. ,
}
string ,
}
,
$schema:
{
Description: Common error response for Azure Maps APIs to return error details for failed operations. ,
}
{
error:
{
Description: The error detail. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}